package com.tlkj.common.curd.entity;

import lombok.Getter;
import lombok.Setter;

/**
 * API参数 - 实体
 * @author flyong86
 * @since 2024年6月19日
 */
@Getter
@Setter
public class ApiParams extends BaseEntity {
    private static final long serialVersionUID = -6796519131704159744L;

    /** ID */
    private String id;

    /** 接口ID */
    private String apiId;

    /** 参数名 */
    private String name;

    /** 字段名 */
    private String field;

    /** 描述 */
    private String desc;

    /** 数据类型;String、Int、Float、Boolean、Date、Datetime、Time */
    private String dataType;

    /** 是否必须;0：非必需 1：必须 */
    private Boolean required;

    /** 示例值 */
    private String sampleVal;

    /** 默认值 */
    private String defaultVal;

    /** 参数类型;0：请求参数 1：返回参数 */
    private Integer paramType;

    @Getter
    public enum ParamType {
        REQUEST(0),
        RETURN(1);
        final int val;

        ParamType(int val) {
            this.val = val;
        }

    }
}
